home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_400 / 425_01 / lzpipe / trees.c < prev    next >
Encoding:
C/C++ Source or Header  |  1994-03-13  |  38.5 KB  |  1,051 lines
  1. /*
  2.  The following sorce code is derived from Info-Zip 'zip' 2.01
  3.  distribution copyrighted by Mark Adler, Richard B. Wales,
  4.  Jean-loup Gailly, Kai Uwe Rommel, Igor Mandrichenko and John Bush.
  5. */
  6.  
  7. /*
  8.  *  trees.c by Jean-loup Gailly
  9.  *
  10.  *  This is a new version of im_ctree.c originally written by Richard B. Wales
  11.  *  for the defunct implosion method.
  12.  *
  13.  *  PURPOSE
  14.  *
  15.  *      Encode various sets of source values using variable-length
  16.  *      binary code trees.
  17.  *
  18.  *  DISCUSSION
  19.  *
  20.  *      The PKZIP "deflation" process uses several Huffman trees. The more
  21.  *      common source values are represented by shorter bit sequences.
  22.  *
  23.  *      Each code tree is stored in the ZIP file in a compressed form
  24.  *      which is itself a Huffman encoding of the lengths of
  25.  *      all the code strings (in ascending order by source values).
  26.  *      The actual code strings are reconstructed from the lengths in
  27.  *      the UNZIP process, as described in the "application note"
  28.  *      (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
  29.  *
  30.  *  REFERENCES
  31.  *
  32.  *      Lynch, Thomas J.
  33.  *          Data Compression:  Techniques and Applications, pp. 53-55.
  34.  *          Lifetime Learning Publications, 1985.  ISBN 0-534-03418-7.
  35.  *
  36.  *      Storer, James A.
  37.  *          Data Compression:  Methods and Theory, pp. 49-50.
  38.  *          Computer Science Press, 1988.  ISBN 0-7167-8156-5.
  39.  *
  40.  *      Sedgewick, R.
  41.  *          Algorithms, p290.
  42.  *          Addison-Wesley, 1983. ISBN 0-201-06672-6.
  43.  *
  44.  *  INTERFACE
  45.  *
  46.  *      int ct_init (void)
  47.  *          Allocate the match buffer and initialize the various tables.
  48.  *
  49.  *      int ct_tally(int dist, int lc);
  50.  *          Save the match info and tally the frequency counts.
  51.  *          Return true if the current block must be flushed.
  52.  *
  53.  *      long flush_block (char *buf, ulg stored_len, int eof)
  54.  *          Determine the best encoding for the current block: dynamic trees,
  55.  *          static trees or store, and output the encoded block to the zip
  56.  *          file. Returns the total compressed length for the file so far.
  57.  */
  58.  
  59. #include "modern.h"
  60. #include "zalloc.h"
  61. #include "zipdefs.h"
  62. #include "zipguts.h"
  63. #include "lzpipe.h"
  64.  
  65. #define MAX_BITS 15
  66. /* All codes must not exceed MAX_BITS bits */
  67.  
  68. #define MAX_BL_BITS 7
  69. /* Bit length codes must not exceed MAX_BL_BITS bits */
  70.  
  71. #define LENGTH_CODES 29
  72. /* number of length codes, not counting the special END_BLOCK code */
  73.  
  74. #define LITERALS  256
  75. /* number of literal bytes 0..255 */
  76.  
  77. #define END_BLOCK 256
  78. /* end of block literal code */
  79.  
  80. #define L_CODES (LITERALS+1+LENGTH_CODES)
  81. /* number of Literal or Length codes, including the END_BLOCK code */
  82.  
  83. #define D_CODES   30
  84. /* number of distance codes */
  85.  
  86. #define BL_CODES  19
  87. /* number of codes used to transfer the bit lengths */
  88.  
  89. static int near extra_lbits[LENGTH_CODES] /* extra bits for each length code */
  90.    = {0,0,0,0,0,0,0,0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,0};
  91.  
  92. static int near extra_dbits[D_CODES] /* extra bits for each distance code */
  93.    = {0,0,0,0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9,9,10,10,11,11,12,12,13,13};
  94.  
  95. static int near extra_blbits[BL_CODES]/* extra bits for each bit length code */
  96.    = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,3,7};
  97.  
  98. #define STORED_BLOCK 0
  99. #define STATIC_TREES 1
  100. #define DYN_TREES    2
  101. /* The three kinds of block type */
  102.  
  103. #ifndef LIT_BUFSIZE
  104. #  ifdef SMALL_MEM
  105. #    define LIT_BUFSIZE  0x2000
  106. #  else
  107. #  ifdef MEDIUM_MEM
  108. #    define LIT_BUFSIZE  0x4000
  109. #  else
  110. #    define LIT_BUFSIZE  0x8000
  111. #  endif
  112. #  endif
  113. #endif
  114. #define DIST_BUFSIZE  LIT_BUFSIZE
  115. /* Sizes of match buffers for literals/lengths and distances.  There are
  116.  * 4 reasons for limiting LIT_BUFSIZE to 64K:
  117.  *   - frequencies can be kept in 16 bit counters
  118.  *   - if compression is not successful for the first block, all input data is
  119.  *     still in the window so we can still emit a stored block even when input
  120.  *     comes from standard input.  (This can also be done for all blocks if
  121.  *     LIT_BUFSIZE is not greater than 32K.)
  122.  *   - if compression is not successful for a file smaller than 64K, we can
  123.  *     even emit a stored file instead of a stored block (saving 5 bytes).
  124.  *   - creating new Huffman trees less frequently may not provide fast
  125.  *     adaptation to changes in the input data statistics. (Take for
  126.  *     example a binary file with poorly compressible code followed by
  127.  *     a highly compressible string table.) Smaller buffer sizes give
  128.  *     fast adaptation but have of course the overhead of transmitting trees
  129.  *     more frequently.
  130.  *   - I can't count above 4
  131.  * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
  132.  * memory at the expense of compression). Some optimizations would be possible
  133.  * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
  134.  */
  135.  
  136. #define REP_3_6      16
  137. /* repeat previous bit length 3-6 times (2 bits of repeat count) */
  138.  
  139. #define REPZ_3_10    17
  140. /* repeat a zero length 3-10 times  (3 bits of repeat count) */
  141.  
  142. #define REPZ_11_138  18
  143. /* repeat a zero length 11-138 times  (7 bits of repeat count) */
  144.  
  145. /* Data structure describing a single value and its code string. */
  146. typedef struct ct_data {
  147.     union {
  148.         ush  freq;       /* frequency count */
  149.         ush  code;       /* bit string */
  150.     } fc;
  151.     union {
  152.         ush  dad;        /* father node in Huffman tree */
  153.         ush  len;        /* length of bit string */
  154.     } dl;
  155. } ct_data;
  156.  
  157. #define Freq fc.freq
  158. #define Code fc.code
  159. #define Dad  dl.dad
  160. #define Len  dl.len
  161.  
  162. #define HEAP_SIZE (2*L_CODES+1)
  163. /* maximum heap size */
  164.  
  165. static ct_data near dyn_ltree[HEAP_SIZE];   /* literal and length tree */
  166. static ct_data near dyn_dtree[2*D_CODES+1]; /* distance tree */
  167.  
  168. static ct_data near static_ltree[L_CODES+2];
  169. /* The static literal tree. Since the bit lengths are imposed, there is no
  170.  * need for the L_CODES extra codes used during heap construction. However
  171.  * The codes 286 and 287 are needed to build a canonical tree (see ct_init
  172.  * below).
  173.  */
  174.  
  175. static ct_data near static_dtree[D_CODES];
  176. /* The static distance tree. (Actually a trivial tree since all codes use
  177.  * 5 bits.)
  178.  */
  179.  
  180. static ct_data near bl_tree[2*BL_CODES+1];
  181. /* Huffman tree for the bit lengths */
  182.  
  183. typedef struct tree_desc {
  184.     ct_data near *dyn_tree;      /* the dynamic tree */
  185.     ct_data near *static_tree;   /* corresponding static tree or NULL */
  186.     int     near *extra_bits;    /* extra bits for each code or NULL */
  187.     int     extra_base;          /* base index for extra_bits */
  188.     int     elems;               /* max number of elements in the tree */
  189.     int     max_length;          /* max bit length for the codes */
  190.     int     max_code;            /* largest code with non zero frequency */
  191. } tree_desc;
  192.  
  193. static tree_desc near l_desc =
  194. {dyn_ltree, static_ltree, extra_lbits, LITERALS+1, L_CODES, MAX_BITS, 0};
  195.  
  196. static tree_desc near d_desc =
  197. {dyn_dtree, static_dtree, extra_dbits, 0,          D_CODES, MAX_BITS, 0};
  198.  
  199. static tree_desc near bl_desc =
  200. {bl_tree, (ct_data near *)0, extra_blbits, 0,     BL_CODES, MAX_BL_BITS, 0};
  201.  
  202. static ush near bl_count[MAX_BITS+1];
  203. /* number of codes at each bit length for an optimal tree */
  204.  
  205. static uch near bl_order[BL_CODES]
  206.    = {16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15};
  207. /* The lengths of the bit length codes are sent in order of decreasing
  208.  * probability, to avoid transmitting the lengths for unused bit length codes.
  209.  */
  210.  
  211. static int near heap[2*L_CODES+1]; /* heap used to build the Huffman trees */
  212. static int heap_len;               /* number of elements in the heap */
  213. static int heap_max;               /* element of largest frequency */
  214. /* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
  215.  * The same heap array is used to build all trees.
  216.  */
  217.  
  218. static uch near depth[2*L_CODES+1];
  219. /* Depth of each subtree used as tie breaker for trees of equal frequency */
  220.  
  221. static uch length_code[MAX_MATCH-MIN_MATCH+1];
  222. /* length code for each normalized match length (0 == MIN_MATCH) */
  223.  
  224. static uch dist_code[512];
  225. /* distance codes. The first 256 values correspond to the distances
  226.  * 3 .. 258, the last 256 values correspond to the top 8 bits of
  227.  * the 15 bit distances.
  228.  */
  229.  
  230. static int near base_length[LENGTH_CODES];
  231. /* First normalized length for each code (0 = MIN_MATCH) */
  232.  
  233. static int near base_dist[D_CODES];
  234. /* First normalized distance for each code (0 = distance of 1) */
  235.  
  236. #ifndef DYN_ALLOC
  237.   static uch far l_buf[LIT_BUFSIZE];  /* buffer for literals/lengths */
  238.   static ush far d_buf[DIST_BUFSIZE]; /* buffer for distances */
  239. #else
  240.   uch far *l_buf = NULL;
  241.   ush far *d_buf = NULL;
  242. #endif
  243. #ifndef zalloc
  244.    void far *p_l_buf = NULL;
  245.    void far *p_d_buf = NULL;
  246. #else
  247. #  define p_l_buf l_buf
  248. #  define p_d_buf d_buf
  249. #endif
  250.  
  251. static uch near flag_buf[(LIT_BUFSIZE/8)];
  252. /* flag_buf is a bit array distinguishing literals from lengths in
  253.  * l_buf, and thus indicating the presence or absence of a distance.
  254.  */
  255.  
  256. static unsigned last_lit;    /* running index in l_buf */
  257. static unsigned last_dist;   /* running index in d_buf */
  258. static unsigned last_flags;  /* running index in flag_buf */
  259. static uch flags;            /* current flags not yet saved in flag_buf */
  260. static uch flag_bit;         /* current bit used in flags */
  261. /* bits are filled in flags starting at bit 0 (least significant).
  262.  * Note: these flags are overkill in the current code since we don't
  263.  * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
  264.  */
  265.  
  266. static ulg opt_len;        /* bit length of current block with optimal trees */
  267. static ulg static_len;     /* bit length of current block with static trees */
  268.  
  269.        ulg compressed_len; /* total bit length of compressed file */
  270.  
  271. static ulg input_len;      /* total byte length of input file */
  272. /* input_len is for debugging only since we can get it by other means. */
  273.  
  274. #ifdef DEBUG
  275. extern ulg bits_sent;  /* bit length of the compressed data */
  276. extern ulg isize;      /* byte length of input file */
  277. #endif
  278.  
  279. extern long block_start;       /* window offset of current block */
  280. extern unsigned near strstart; /* window offset of current string */
  281.  
  282. static void init_block     OF((void));
  283. static void pqdownheap     OF((ct_data near *tree, int k));
  284. static void gen_bitlen     OF((tree_desc near *desc));
  285. static void gen_codes      OF((ct_data near *tree, int max_code));
  286. static void build_tree     OF((tree_desc near *desc));
  287. static void scan_tree      OF((ct_data near *tree, int max_code));
  288. static int  send_tree      OF((ct_data near *tree, int max_code));
  289. static int  build_bl_tree  OF((void));
  290. static int  send_all_trees OF((int lcodes, int dcodes, int blcodes));
  291. static int  compress_block OF((ct_data near *ltree, ct_data near *dtree));
  292.  
  293. #define send_code(c, tree) send_bits(tree[c].Code, tree[c].Len)
  294. /* Send a code of the given tree. c and tree must not have side effects */
  295.  
  296. #define d_code(dist) \
  297.    ((dist) < 256 ? dist_code[dist] : dist_code[256+((dist)>>7)])
  298. /* Mapping from a distance to a distance code. dist is the distance - 1 and
  299.  * must not have side effects. dist_code[256] and dist_code[257] are never
  300.  * used.
  301.  */
  302.  
  303. #define MAX(a,b) (a >= b ? a : b)
  304. /* the arguments must not have side effects */
  305.  
  306. #ifdef DYN_ALLOC
  307. void ct_free()
  308. {
  309.    if (d_buf) { zfree(p_d_buf); d_buf = NULL; }
  310.    if (l_buf) { zfree(p_l_buf); l_buf = NULL; }
  311. }
  312.  
  313. int ct_alloc()
  314. {
  315.    if (!p_d_buf) {
  316.       d_buf = (ush far*)zalloc(&p_d_buf, DIST_BUFSIZE, sizeof(ush));
  317.       if (!p_d_buf) return ZNOMEM;
  318.    }
  319.    if (!p_l_buf) {
  320.       /* Avoid using the value 64K on 16 bit machines */
  321.       l_buf = (uch far*)zalloc(&p_l_buf, LIT_BUFSIZE/2, 2);
  322.       if (!p_l_buf) {
  323.          ct_free(); return ZNOMEM;
  324.       }
  325.    }
  326.    return 0;
  327. }
  328.  
  329. #endif
  330.  
  331. /* Allocate the match buffer and initialize the various tables. */
  332. int ct_init()
  333. {
  334.    register n;    /* iterates over tree elements */
  335.    int bits;      /* bit counter */
  336.    int length;    /* length value */
  337.    register code; /* code value */
  338.    int dist;      /* distance index */
  339.  
  340.     compressed_len = input_len = 0L;
  341.  
  342. #ifdef DYN_ALLOC
  343.    if (ct_alloc() != 0) return ZNOMEM;
  344. #endif
  345.    if (static_dtree[0].Len != 0) return 0; /* ct_init already called */
  346.  
  347.    /* Initialize the mapping length (0..255) -> length code (0..28) */
  348.    length = 0;
  349.    for (code=0; code < LENGTH_CODES-1; code++) {
  350.       base_length[code] = length;
  351.       for (n=0; n < (1<<extra_lbits[code]); n++) {
  352.          length_code[length++] = (uch)code;
  353.       }
  354.    }
  355.    Assert (length == 256, "ct_init: length != 256");
  356.     /* Note that the length 255 (match length 258) can be represented
  357.        in two different ways: code 284 + 5 bits or code 285, so we
  358.        overwrite length_code[255] to use the best encoding:     */
  359.    length_code[length-1] = (uch)code;
  360.  
  361.    /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
  362.    dist = 0;
  363.    for (code=0 ; code < 16; code++) {
  364.       base_dist[code] = dist;
  365.       for (n=0; n < (1<<extra_dbits[code]); n++) {
  366.          dist_code[dist++] = (uch)code;
  367.       }
  368.    }
  369.    Assert (dist == 256, "ct_init: dist != 256");
  370.    dist >>= 7; /* from now on, all distances are divided by 128 */
  371.    for (; code < D_CODES; code++) {
  372.       base_dist[code] = dist << 7;
  373.       for (n=0; n < (1<<(extra_dbits[code]-7)); n++) {
  374.          dist_code[256 + dist++] = (uch)code;
  375.       }
  376.    }
  377.    Assert (dist == 256, "ct_init: 256+dist != 512");
  378.  
  379.    /* Construct the codes of the static literal tree */
  380.    for (bits=0; bits <= MAX_BITS; bits++) bl_count[bits] = 0;
  381.    n = 0;
  382.    while (n <= 143) static_ltree[n++].Len = 8, bl_count[8]++;
  383.    while (n <= 255) static_ltree[n++].Len = 9, bl_count[9]++;
  384.    while (n <= 279) static_ltree[n++].Len = 7, bl_count[7]++;
  385.    while (n <= 287) static_ltree[n++].Len = 8, bl_count[8]++;
  386.    /* Codes 286 and 287 do not exist, but we must include them in the tree
  387.       construction to get a canonical Huffman tree (longest code all ones) */
  388.    gen_codes((ct_data near *)static_ltree, L_CODES+1);
  389.  
  390.    /* The static distance tree is trivial: */
  391.    for (n=0; n < D_CODES; n++) {
  392.       static_dtree[n].Len = 5;
  393.       static_dtree[n].Code = bi_reverse(n, 5);
  394.    }
  395.  
  396.    /* Initialize the first block of the first file: */
  397.    init_block();
  398.    return 0;
  399. }
  400.  
  401. /* Initialize a new block. */
  402. static void init_block()
  403. {
  404.    register n; /* iterates over tree elements */
  405.  
  406.    /* Initialize the trees. */
  407.    for (n=0; n < L_CODES;  n++) dyn_ltree[n].Freq = 0;
  408.    for (n=0; n < D_CODES;  n++) dyn_dtree[n].Freq = 0;
  409.    for (n=0; n < BL_CODES; n++) bl_tree[n].Freq = 0;
  410.  
  411.    dyn_ltree[END_BLOCK].Freq = 1;
  412.    opt_len = static_len = 0L;
  413.    last_lit = last_dist = last_flags = 0;
  414.    flags = 0; flag_bit = 1;
  415. }
  416.  
  417. #define SMALLEST 1
  418. /* Index within the heap array of least frequent node in the Huffman tree */
  419.  
  420. /*
  421.  * Remove the smallest element from the heap and recreate the heap with
  422.  * one less element. Updates heap and heap_len.
  423.  */
  424. #define pqremove(tree, top) \
  425. {\
  426.     top = heap[SMALLEST]; \
  427.     heap[SMALLEST] = heap[heap_len--]; \
  428.     pqdownheap(tree, SMALLEST); \
  429. }
  430.  
  431. /*
  432.  * Compares to subtrees, using the tree depth as tie breaker when
  433.  * the subtrees have equal frequency. This minimizes the worst case length.
  434.  */
  435. #define smaller(tree, n, m) \
  436.    (tree[n].Freq < tree[m].Freq || \
  437.    (tree[n].Freq == tree[m].Freq && depth[n] <= depth[m]))
  438.  
  439. /*
  440.  * Restore the heap property by moving down the tree starting at node k,
  441.  * exchanging a node with the smallest of its two sons if necessary, stopping
  442.  * when the heap property is re-established (each father smaller than its
  443.  * two sons).
  444.  */
  445. static void pqdownheap(tree, k)
  446.     ct_data near *tree;  /* the tree to restore */
  447.     int k;               /* node to move down */
  448. {
  449.     int v = heap[k];
  450.     int j = k << 1;  /* left son of k */
  451.     int htemp;       /* required because of bug in SASC compiler */
  452.  
  453.     while (j <= heap_len) {
  454.         /* Set j to the smallest of the two sons: */
  455.         if (j < heap_len && smaller(tree, heap[j+1], heap[j])) j++;
  456.  
  457.         /* Exit if v is smaller than both sons */
  458.         htemp = heap[j];
  459.         if (smaller(tree, v, htemp)) break;
  460.  
  461.         /* Exchange v with the smallest son */
  462.         heap[k] = htemp;
  463.         k = j;
  464.  
  465.         /* And continue down the tree, setting j to the left son of k */
  466.         j <<= 1;
  467.     }
  468.     heap[k] = v;
  469. }
  470.  
  471. /*
  472.  * Compute the optimal bit lengths for a tree and update the total bit length
  473.  * for the current block.
  474.  * IN assertion: the fields freq and dad are set, heap[heap_max] and
  475.  *    above are the tree nodes sorted by increasing frequency.
  476.  * OUT assertions: the field len is set to the optimal bit length, the
  477.  *     array bl_count contains the frequencies for each bit length.
  478.  *     The length opt_len is updated; static_len is also updated if stree is
  479.  *     not null.
  480.  */
  481. static void gen_bitlen(desc)
  482.     tree_desc near *desc; /* the tree descriptor */
  483. {
  484.     ct_data near *tree  = desc->dyn_tree;
  485.     int near *extra     = desc->extra_bits;
  486.     int base            = desc->extra_base;
  487.     int max_code        = desc->max_code;
  488.     int max_length      = desc->max_length;
  489.     ct_data near *stree = desc->static_tree;
  490.     int h;              /* heap index */
  491.     int n, m;           /* iterate over the tree elements */
  492.     int bits;           /* bit length */
  493.     int xbits;          /* extra bits */
  494.     ush f;              /* frequency */
  495.     int overflow = 0;   /* number of elements with bit length too large */
  496.  
  497.     for (bits = 0; bits <= MAX_BITS; bits++) bl_count[bits] = 0;
  498.  
  499.     /* In a first pass, compute the optimal bit lengths (which may
  500.      * overflow in the case of the bit length tree).
  501.      */
  502.     tree[heap[heap_max]].Len = 0; /* root of the heap */
  503.  
  504.     for (h = heap_max+1; h < HEAP_SIZE; h++) {
  505.         n = heap[h];
  506.         bits = tree[tree[n].Dad].Len + 1;
  507.         if (bits > max_length) bits = max_length, overflow++;
  508.         tree[n].Len = bits;
  509.         /* We overwrite tree[n].Dad which is no longer needed */
  510.  
  511.         if (n > max_code) continue; /* not a leaf node */
  512.  
  513.         bl_count[bits]++;
  514.         xbits = 0;
  515.         if (n >= base) xbits = extra[n-base];
  516.         f = tree[n].Freq;
  517.         opt_len += (ulg)f * (bits + xbits);
  518.         if (stree) static_len += (ulg)f * (stree[n].Len + xbits);
  519.     }
  520.     if (overflow == 0) return;
  521.  
  522.     Trace((stderr,"\nbit length overflow\n"));
  523.     /* This happens for example on obj2 and pic of the Calgary corpus */
  524.  
  525.     /* Find the first bit length which could increase: */
  526.     do {
  527.         bits = max_length-1;
  528.         while (bl_count[bits] == 0) bits--;
  529.         bl_count[bits]--;      /* move one leaf down the tree */
  530.         bl_count[bits+1] += 2; /* move one overflow item as its brother */
  531.         bl_count[max_length]--;
  532.         /* The brother of the overflow item also moves one step up,
  533.          * but this does not affect bl_count[max_length]
  534.          */
  535.         overflow -= 2;
  536.     } while (overflow > 0);
  537.  
  538.     /* Now recompute all bit lengths, scanning in increasing frequency.
  539.      * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
  540.      * lengths instead of fixing only the wrong ones. This idea is taken
  541.      * from 'ar' written by Haruhiko Okumura.)
  542.      */
  543.     for (bits = max_length; bits != 0; bits--) {
  544.         n = bl_count[bits];
  545.         while (n != 0) {
  546.             m = heap[--h];
  547.             if (m > max_code) continue;
  548.             if (tree[m].Len != (unsigned) bits) {
  549.                 Trace((stderr,"code %d bits %d->%d\n", m, tree[m].Len, bits));
  550.                 opt_len += ((long)bits-(long)tree[m].Len)*(long)tree[m].Freq;
  551.                 tree[m].Len = bits;
  552.             }
  553.             n--;
  554.         }
  555.     }
  556. }
  557.  
  558. /*
  559.  * Generate the codes for a given tree and bit counts (which need not be
  560.  * optimal).
  561.  * IN assertion: the array bl_count contains the bit length statistics for
  562.  * the given tree and the field len is set for all tree elements.
  563.  * OUT assertion: the field code is set for all tree elements of non
  564.  *     zero code length.
  565.  */
  566. static void gen_codes (tree, max_code)
  567.     ct_data near *tree;        /* the tree to decorate */
  568.     int max_code;              /* largest code with non zero frequency */
  569. {
  570.     ush next_code[MAX_BITS+1]; /* next code value for each bit length */
  571.     ush code = 0;              /* running code value */
  572.     int bits;                  /* bit index */
  573.     int n;                     /* code index */
  574.  
  575.     /* The distribution counts are first used to generate the code values
  576.      * without bit reversal.
  577.      */
  578.     for (bits = 1; bits <= MAX_BITS; bits++) {
  579.         next_code[bits] = code = (code + bl_count[bits-1]) << 1;
  580.     }
  581.     /* Check that the bit counts in bl_count are consistent. The last code
  582.      * must be all ones.
  583.      */
  584.     Assert (code + bl_count[MAX_BITS]-1 == (1<<MAX_BITS)-1,
  585.             "inconsistent bit counts");
  586.     Tracev((stderr,"\ngen_codes: max_code %d ", max_code));
  587.  
  588.     for (n = 0;  n <= max_code; n++) {
  589.         int len = tree[n].Len;
  590.         if (len == 0) continue;
  591.         /* Now reverse the bits */
  592.         tree[n].Code = bi_reverse(next_code[len]++, len);
  593.  
  594.         Tracec(tree != static_ltree, (stderr,"\nn %3d %c l %2d c %4x (%x) ",
  595.              n, (isgraph(n) ? n : ' '), len, tree[n].Code, next_code[len]-1));
  596.     }
  597. }
  598.  
  599. /*
  600.  * Construct one Huffman tree and assigns the code bit strings and lengths.
  601.  * Update the total bit length for the current block.
  602.  * IN assertion: the field freq is set for all tree elements.
  603.  * OUT assertions: the fields len and code are set to the optimal bit length
  604.  *     and corresponding code. The length opt_len is updated; static_len is
  605.  *     also updated if stree is not null. The field max_code is set.
  606.  */
  607. static void build_tree(desc)
  608.     tree_desc near *desc; /* the tree descriptor */
  609. {
  610.     ct_data near *tree   = desc->dyn_tree;
  611.     ct_data near *stree  = desc->static_tree;
  612.     int elems            = desc->elems;
  613.     int n, m;          /* iterate over heap elements */
  614.     int max_code = -1; /* largest code with non zero frequency */
  615.     int node = elems;  /* next internal node of the tree */
  616.  
  617.     /* Construct the initial heap, with least frequent element in
  618.      * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
  619.      * heap[0] is not used.
  620.      */
  621.     heap_len = 0, heap_max = HEAP_SIZE;
  622.  
  623.     for (n = 0; n < elems; n++) {
  624.         if (tree[n].Freq != 0) {
  625.             heap[++heap_len] = max_code = n;
  626.             depth[n] = 0;
  627.         } else {
  628.             tree[n].Len = 0;
  629.         }
  630.     }
  631.  
  632.     /* The pkzip format requires that at least one distance code exists,
  633.      * and that at least one bit should be sent even if there is only one
  634.      * possible code. So to avoid special checks later on we force at least
  635.      * two codes of non zero frequency.
  636.      */
  637.     while (heap_len < 2) {
  638.         int new = heap[++heap_len] = (max_code < 2 ? ++max_code : 0);
  639.         tree[new].Freq = 1;
  640.         depth[new] = 0;
  641.         opt_len--; if (stree) static_len -= stree[new].Len;
  642.         /* new is 0 or 1 so it does not have extra bits */
  643.     }
  644.     desc->max_code = max_code;
  645.  
  646.     /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
  647.      * establish sub-heaps of increasing lengths:
  648.      */
  649.     for (n = heap_len/2; n >= 1; n--) pqdownheap(tree, n);
  650.  
  651.     /* Construct the Huffman tree by repeatedly combining the least two
  652.      * frequent nodes.
  653.      */
  654.     do {
  655.         pqremove(tree, n);   /* n = node of least frequency */
  656.         m = heap[SMALLEST];  /* m = node of next least frequency */
  657.  
  658.         heap[--heap_max] = n; /* keep the nodes sorted by frequency */
  659.         heap[--heap_max] = m;
  660.  
  661.         /* Create a new node father of n and m */
  662.         tree[node].Freq = tree[n].Freq + tree[m].Freq;
  663.         depth[node] = (uch) (MAX(depth[n], depth[m]) + 1);
  664.         tree[n].Dad = tree[m].Dad = node;
  665. #ifdef DUMP_BL_TREE
  666.         if (tree == bl_tree) {
  667.             fprintf(stderr,"\nnode %d(%d), sons %d(%d) %d(%d)",
  668.                     node, tree[node].Freq, n, tree[n].Freq, m, tree[m].Freq);
  669.         }
  670. #endif
  671.         /* and insert the new node in the heap */
  672.         heap[SMALLEST] = node++;
  673.         pqdownheap(tree, SMALLEST);
  674.  
  675.     } while (heap_len >= 2);
  676.  
  677.     heap[--heap_max] = heap[SMALLEST];
  678.  
  679.     /* At this point, the fields freq and dad are set. We can now
  680.      * generate the bit lengths.
  681.      */
  682.     gen_bitlen((tree_desc near *)desc);
  683.  
  684.     /* The field len is now set, we can generate the bit codes */
  685.     gen_codes ((ct_data near *)tree, max_code);
  686. }
  687.  
  688. /* ===========================================================================
  689.  * Scan a literal or distance tree to determine the frequencies of the codes
  690.  * in the bit length tree. Updates opt_len to take into account the repeat
  691.  * counts. (The contribution of the bit length codes will be added later
  692.  * during the construction of bl_tree.)
  693.  */
  694. static void scan_tree (tree, max_code)
  695.     ct_data near *tree; /* the tree to be scanned */
  696.     int max_code;       /* and its largest code of non zero frequency */
  697. {
  698.     int n;                     /* iterates over all tree elements */
  699.     int prevlen = -1;          /* last emitted length */
  700.     int curlen;                /* length of current code */
  701.     int nextlen = tree[0].Len; /* length of next code */
  702.     int count = 0;             /* repeat count of the current code */
  703.     int max_count = 7;         /* max repeat count */
  704.     int min_count = 4;         /* min repeat count */
  705.  
  706.     if (nextlen == 0) max_count = 138, min_count = 3;
  707.     tree[max_code+1].Len = (ush)-1; /* guard */
  708.  
  709.     for (n = 0; n <= max_code; n++) {
  710.         curlen = nextlen; nextlen = tree[n+1].Len;
  711.         if (++count < max_count && curlen == nextlen) {
  712.             continue;
  713.         } else if (count < min_count) {
  714.             bl_tree[curlen].Freq += count;
  715.         } else if (curlen != 0) {
  716.             if (curlen != prevlen) bl_tree[curlen].Freq++;
  717.             bl_tree[REP_3_6].Freq++;
  718.         } else if (count <= 10) {
  719.             bl_tree[REPZ_3_10].Freq++;
  720.         } else {
  721.             bl_tree[REPZ_11_138].Freq++;
  722.         }
  723.         count = 0; prevlen = curlen;
  724.         if (nextlen == 0) {
  725.             max_count = 138, min_count = 3;
  726.         } else if (curlen == nextlen) {
  727.             max_count = 6, min_count = 3;
  728.         } else {
  729.             max_count = 7, min_count = 4;
  730.         }
  731.     }
  732. }
  733.  
  734. /* Send a literal or distance tree in compressed form,
  735.    using the codes in bl_tree. */
  736. static int send_tree (tree, max_code)
  737. ct_data near *tree; /* the tree to be scanned */
  738. int max_code;       /* and its largest code of non zero frequency */
  739. {
  740.    int n;                     /* iterates over all tree elements */
  741.    int prevlen = -1;          /* last emitted length */
  742.    int curlen;                /* length of current code */
  743.    int nextlen = tree[0].Len; /* length of next code */
  744.    int count = 0;             /* repeat count of the current code */
  745.    int max_count = 7;         /* max repeat count */
  746.    int min_count = 4;         /* min repeat count */
  747.  
  748.    /* tree[max_code+1].Len = -1; */  /* guard already set */
  749.    if (nextlen == 0) max_count = 138, min_count = 3;
  750.  
  751.    for (n = 0; n <= max_code; n++) {
  752.       curlen = nextlen; nextlen = tree[n+1].Len;
  753.       if (++count < max_count && curlen == nextlen) {
  754.          continue;
  755.       } else if (count < min_count) {
  756.          do {
  757.             if (send_code(curlen, bl_tree) != 0) goto error;
  758.          } while (--count != 0);
  759.       } else if (curlen != 0) {
  760.          if (curlen != prevlen) {
  761.             if (send_code(curlen, bl_tree) != 0) goto error;
  762.             count--;
  763.          }
  764.          Assert(count >= 3 && count <= 6, " 3_6?");
  765.          if (send_code(REP_3_6, bl_tree) != 0 ||
  766.              send_bits(count-3, 2) != 0) goto error;
  767.       } else if (count <= 10) {
  768.          if (send_code(REPZ_3_10, bl_tree) != 0 ||
  769.              send_bits(count-3, 3) != 0) goto error;
  770.       } else {
  771.          if (send_code(REPZ_11_138, bl_tree) != 0 ||
  772.              send_bits(count-11, 7) != 0) goto error;
  773.       }
  774.       count = 0; prevlen = curlen;
  775.       if (nextlen == 0) {
  776.          max_count = 138, min_count = 3;
  777.       } else if (curlen == nextlen) {
  778.          max_count = 6, min_count = 3;
  779.       } else {
  780.          max_count = 7, min_count = 4;
  781.       }
  782.    }
  783.    return 0;
  784. error:
  785.    return ZWRITE;
  786. }
  787.  
  788. /* Construct the Huffman tree for the bit lengths and return the index in
  789.    bl_order of the last bit length code to send. */
  790. static int build_bl_tree()
  791. {
  792.     int max_blindex;  /* index of last bit length code of non zero freq */
  793.  
  794.     /* Determine the bit length frequencies for literal and distance trees */
  795.     scan_tree((ct_data near *)dyn_ltree, l_desc.max_code);
  796.     scan_tree((ct_data near *)dyn_dtree, d_desc.max_code);
  797.  
  798.     /* Build the bit length tree: */
  799.     build_tree((tree_desc near *)(&bl_desc));
  800.     /* opt_len now includes the length of the tree representations, except
  801.      * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
  802.      */
  803.  
  804.     /* Determine the number of bit length codes to send. The pkzip format
  805.      * requires that at least 4 bit length codes be sent. (appnote.txt says
  806.      * 3 but the actual value used is 4.)
  807.      */
  808.     for (max_blindex = BL_CODES-1; max_blindex >= 3; max_blindex--) {
  809.         if (bl_tree[bl_order[max_blindex]].Len != 0) break;
  810.     }
  811.     /* Update opt_len to include the bit length tree and counts */
  812.     opt_len += 3*(max_blindex+1) + 5+5+4;
  813.     Tracev((stderr, "\ndyn trees: dyn %ld, stat %ld", opt_len, static_len));
  814.  
  815.     return max_blindex;
  816. }
  817.  
  818. /* Send the header for a block using dynamic Huffman trees: the counts, the
  819.  * lengths of the bit length codes, the literal tree and the distance tree.
  820.  * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4. */
  821. static int send_all_trees(lcodes, dcodes, blcodes)
  822. int lcodes, dcodes, blcodes; /* number of codes for each tree */
  823. {
  824.    int rank;                    /* index in bl_order */
  825.  
  826.    Assert (lcodes >= 257 && dcodes >= 1 && blcodes >= 4, "not enough codes");
  827.    Assert (lcodes <= L_CODES && dcodes <= D_CODES && blcodes <= BL_CODES,
  828.            "too many codes");
  829.    Tracev((stderr, "\nbl counts: "));
  830.    if (send_bits(lcodes-257, 5) != 0) goto error;
  831.    /* not +255 as stated in appnote.txt 1.93a or -256 in 2.04c */
  832.    if (send_bits(dcodes-1,   5) != 0) goto error;
  833.    /* not -3 as stated in appnote.txt */
  834.    if (send_bits(blcodes-4,  4) != 0) goto error;
  835.    for (rank = 0; rank < blcodes; rank++) {
  836.       Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
  837.       if (send_bits(bl_tree[bl_order[rank]].Len, 3) != 0) goto error;
  838.    }
  839.    Tracev((stderr, "\nbl tree: sent %ld", bits_sent));
  840.  
  841.    /* send the literal tree */
  842.    if (send_tree((ct_data near *)dyn_ltree, lcodes-1) != 0) goto error;
  843.    Tracev((stderr, "\nlit tree: sent %ld", bits_sent));
  844.  
  845.    /* send the distance tree */
  846.    if (send_tree((ct_data near *)dyn_dtree, dcodes-1) != 0) goto error;
  847.    Tracev((stderr, "\ndist tree: sent %ld", bits_sent));
  848.    return 0;
  849. error:
  850.    return ZWRITE;
  851. }
  852.  
  853. /* ===========================================================================
  854.  * Determine the best encoding for the current block: dynamic trees, static
  855.  * trees or store, and output the encoded block to the zip file. This function
  856.  * returns the total compressed length for the file so far.
  857.  */
  858. ulg flush_block(buf, stored_len, eof)
  859. char far *buf;    /* input block, or NULL if too old */
  860. ulg stored_len;   /* length of input block */
  861. int eof;          /* true if this is the last block for a file */
  862. {
  863.    ulg opt_lenb, static_lenb; /* opt_len and static_len in bytes */
  864.    int max_blindex;  /* index of last bit length code of non zero freq */
  865.  
  866.    flag_buf[last_flags] = flags; /* Save the flags for the last 8 items */
  867.  
  868.    /* Construct the literal and distance trees */
  869.    build_tree((tree_desc near *)(&l_desc));
  870.    Tracev((stderr, "\nlit data: dyn %ld, stat %ld", opt_len, static_len));
  871.  
  872.    build_tree((tree_desc near *)(&d_desc));
  873.    Tracev((stderr, "\ndist data: dyn %ld, stat %ld", opt_len, static_len));
  874.    /* At this point, opt_len and static_len are the total bit lengths of
  875.     * the compressed block data, excluding the tree representations.
  876.     */
  877.  
  878.    /* Build the bit length tree for the above two trees, and get the index
  879.     * in bl_order of the last bit length code to send.
  880.     */
  881.    max_blindex = build_bl_tree();
  882.  
  883.    /* Determine the best encoding. Compute first the block length in bytes */
  884.    opt_lenb = (opt_len+3+7)>>3;
  885.    static_lenb = (static_len+3+7)>>3;
  886.    input_len += stored_len; /* for debugging only */
  887.  
  888.    Trace((stderr, "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
  889.            opt_lenb, opt_len, static_lenb, static_len, stored_len,
  890.            last_lit, last_dist));
  891.  
  892.    if (static_lenb <= opt_lenb) opt_lenb = static_lenb;
  893.  
  894. #ifdef FORCE_METHOD
  895.    if (level == 2 && buf) /* force stored block */
  896. #else
  897.    if (stored_len+4 <= opt_lenb && buf) /* 4: two words for the lengths */
  898. #endif
  899.    {
  900.        /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
  901.         * Otherwise we can't have processed more than WSIZE input bytes since
  902.         * the last block flush, because compression would have been
  903.         * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
  904.         * transform a block into a stored block.
  905.         */
  906.        /* send block type */
  907.        if (send_bits((STORED_BLOCK<<1)+eof, 3) != 0) goto error;
  908.        compressed_len = (compressed_len + 3 + 7) & ~7L;
  909.        compressed_len += (stored_len + 4) << 3;
  910.        /* with header */
  911.        if (copy_block(buf, (unsigned)stored_len, 1) != 0) goto error;
  912.    }
  913. #ifdef FORCE_METHOD
  914.    else if (level == 3) /* force static trees */
  915. #else
  916.    else if (static_lenb == opt_lenb)
  917. #endif
  918.    {
  919.        if (send_bits((STATIC_TREES<<1)+eof, 3) != 0 ||
  920.            compress_block((ct_data near *)static_ltree,
  921.                           (ct_data near *)static_dtree) != 0) goto error;
  922.        compressed_len += 3 + static_len;
  923.    } else {
  924.        if (send_bits((DYN_TREES<<1)+eof, 3) != 0 ||
  925.            send_all_trees(l_desc.max_code+1,
  926.                           d_desc.max_code+1,
  927.                           max_blindex+1) != 0 ||
  928.            compress_block((ct_data near *)dyn_ltree,
  929.                           (ct_data near *)dyn_dtree) != 0) goto error;
  930.        compressed_len += 3 + opt_len;
  931.    }
  932.    Assert (compressed_len == bits_sent, "bad compressed size");
  933.    init_block();
  934.  
  935.    if (eof) {
  936.       Assert (input_len == isize, "bad input size");
  937.       if (bi_windup() != 0) goto error;
  938.       compressed_len += 7;  /* align on byte boundary */
  939.    }
  940.    Tracev((stderr,"\ncomprlen %lu(%lu) ", compressed_len>>3,
  941.           compressed_len-7*eof));
  942.  
  943.    return compressed_len >> 3;
  944. error:
  945.    return -1L;
  946. }
  947.  
  948. /* Save the match info and tally the frequency counts.
  949.    Return true if the current block must be flushed. */
  950. int ct_tally (dist, lc)
  951. int dist; /* distance of matched string */
  952. int lc;   /* match length-MIN_MATCH or unmatched char (if dist==0) */
  953. {
  954.    l_buf[last_lit++] = (uch)lc;
  955.    if (dist == 0) {
  956.       /* lc is the unmatched char */
  957.       dyn_ltree[lc].Freq++;
  958.    } else {
  959.       /* Here, lc is the match length - MIN_MATCH */
  960.       dist--;             /* dist = match distance - 1 */
  961.       Assert((ush)dist < (ush)MAX_DIST &&
  962.              (ush)lc <= (ush)(MAX_MATCH-MIN_MATCH) &&
  963.              (ush)d_code(dist) < (ush)D_CODES,  "ct_tally: bad match");
  964.  
  965.       dyn_ltree[length_code[lc]+LITERALS+1].Freq++;
  966.       dyn_dtree[d_code(dist)].Freq++;
  967.  
  968.       d_buf[last_dist++] = dist;
  969.       flags |= flag_bit;
  970.    }
  971.    flag_bit <<= 1;
  972.  
  973.    /* Output the flags if they fill a byte: */
  974.    if ((last_lit & 7) == 0) {
  975.       flag_buf[last_flags++] = flags;
  976.       flags = 0, flag_bit = 1;
  977.    }
  978.    /* Try to guess if it is profitable to stop the current block here */
  979.    if (deflate_level > 2 && (last_lit & 0xfff) == 0) {
  980.       /* Compute an upper bound for the compressed length */
  981.       ulg out_length = (ulg)last_lit*8L;
  982.       ulg in_length = (ulg)strstart-block_start;
  983.       int dcode;
  984.       for (dcode = 0; dcode < D_CODES; dcode++) {
  985.          out_length += (ulg)dyn_dtree[dcode].Freq*(5L+extra_dbits[dcode]);
  986.       }
  987.       out_length >>= 3;
  988.       Trace((stderr,"\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
  989.             last_lit, last_dist, in_length, out_length,
  990.             100L - out_length*100L/in_length));
  991.        if (last_dist < last_lit/2 && out_length < in_length/2) return 1;
  992.    }
  993.    return (last_lit == LIT_BUFSIZE-1 || last_dist == DIST_BUFSIZE);
  994.    /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
  995.     * on 16 bit machines and because stored blocks are restricted to
  996.     * 64K-1 bytes. */
  997. }
  998.  
  999. /* Send the block data compressed using the given Huffman trees */
  1000. static int compress_block(ltree, dtree)
  1001. ct_data near *ltree; /* literal tree */
  1002. ct_data near *dtree; /* distance tree */
  1003. {
  1004.    unsigned dist;      /* distance of matched string */
  1005.    int lc;             /* match length or unmatched char (if dist == 0) */
  1006.    unsigned lx = 0;    /* running index in l_buf */
  1007.    unsigned dx = 0;    /* running index in d_buf */
  1008.    unsigned fx = 0;    /* running index in flag_buf */
  1009.    uch flag = 0;       /* current flags */
  1010.    unsigned code;      /* the code to send */
  1011.    int extra;          /* number of extra bits to send */
  1012.  
  1013.    if (last_lit != 0)
  1014.       do {
  1015.          if ((lx & 7) == 0) flag = flag_buf[fx++];
  1016.          lc = l_buf[lx++];
  1017.          if ((flag & 1) == 0) {
  1018.             /* send a literal byte */
  1019.             if (send_code(lc, ltree) != 0) goto error;
  1020.             Tracecv(isgraph(lc), (stderr," '%c' ", lc));
  1021.          } else {
  1022.             /* Here, lc is the match length - MIN_MATCH */
  1023.             code = length_code[lc];
  1024.             /* send the length code */
  1025.             if (send_code(code+LITERALS+1, ltree) != 0) goto error;
  1026.             if ((extra = extra_lbits[code]) != 0) {
  1027.                lc -= base_length[code];
  1028.                /* send the extra length bits */
  1029.                if (send_bits(lc, extra) != 0) goto error;
  1030.             }
  1031.             dist = d_buf[dx++];
  1032.             /* Here, dist is the match distance - 1 */
  1033.             code = d_code(dist);
  1034.             Assert(code < D_CODES, "bad d_code");
  1035.  
  1036.             /* send the distance code */
  1037.             if (send_code(code, dtree) != 0) goto error;
  1038.             if ((extra = extra_dbits[code]) != 0) {
  1039.                dist -= base_dist[code];
  1040.                /* send the extra distance bits */
  1041.                if (send_bits(dist, extra) != 0) goto error;
  1042.              }
  1043.          } /* literal or match pair ? */
  1044.          flag >>= 1;
  1045.      } while (lx < last_lit);
  1046.  
  1047.    return send_code(END_BLOCK, ltree);
  1048. error:
  1049.   return ZWRITE;
  1050. }
  1051.